<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//ZH-CN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta http-equiv="imagetoolbar" content="no" />
	<title>Class UI.ProgressBar</title>
	<link href="../resources/API_Help.css" type="text/css" rel="stylesheet" />
</head>

<body>
<!--打印本页-->
<div class="printCurrentPage">
	<img src="../resources/image/print.gif" align="absmiddle" />&nbsp;
	<a href="ui_ProgressBar_API.html" target="_blank">打印本页</a>
</div><br/>

<!--标题说明-->
<h1>Class UI.ProgressBar</h1>
<b>定义于文件：</b>&nbsp;&nbsp;ui_progressBar.js
<div class="description">将页面对象渲染成进度条控件。</div><br/>
<b>基本语法</b>
<div class="syntax">var progressBar = new <b>UI.ProgressBar</b>( { &lt; <em>id:String|Tag</em> &gt; [ , <em>width:Number|(PER String)</em>,&nbsp;&nbsp;<em>per:Number|(PER String)</em>,&nbsp;&nbsp;<em>style:Number</em> ] } );</div>
<b>参数说明</b>
<div class="parameter">
	<ul>
		<li><em>id</em> : String|Tag</li>
		<div class="subDesc">页面进度条标签ID或是页面进度条标签对象。</div>
		<li><em>width</em> : Number|(PER String)</li>
		<div class="subDesc">(可选参数) 进度条的宽度, 取值: 1-999之间的整数或1-100的百分数, 默认值: 180px。</div>
		<li><em>per</em> : Number|(PER String)</li>
		<div class="subDesc">(可选参数) 进度条的指标条宽度, 取值: 0-1之间的两位小数或1-100的百分数, 默认值：0。</div>
		<li><em>style</em> : Number</li>
		<div class="subDesc">(可选参数) 进度条控件的风格样式, 默认值：0。</div>
	</ul>
</div>
<b>页面标签对象原型</b>
<div class="parameter">
	&lt;div&gt;&lt;/div&gt;
</div>
<b>依赖关系</b>
<div class="parameter">
	<a href="core_API.html">core.js</a>　　<a href="#">webui.js</a>
</div><br/>
<a href="#properties">相关属性</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#methods">相关方法</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#events">相关事件</a>&nbsp;&nbsp;-&nbsp;&nbsp;
<a href="#examples">应用示例</a>
<hr>

<!--相关属性-->
<a name="properties"></a>
<h2>相关属性</h2>
<table width="100%" cellspacing="0">
	<tbody>
		<tr>
			<td class="tableHead" width="83%">所有属性</td>
			<td class="tableHead" width="17%">所属类</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#UI.ProgressBar.dom" class="methodLink">UI.ProgressBar.dom</a>&nbsp;:&nbsp;&lt;div&gt;<br/>
				进度条控件的页面标签对象。
			</td><td class="tableLineRight">UI.ProgressBar</td>
		</tr>
	</tbody>
</table>

<!--相关方法-->
<a name="methods"></a>
<h2>相关方法</h2>
<table width="100%" cellspacing="0">
	<tbody>
		<tr>
			<td class="tableHead" width="83%">所有方法</td>
			<td class="tableHead" width="17%">所属类</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#finish" class="methodLink">finish</a>()&nbsp;:&nbsp;none<br/>
				完成控件当前的进度显示。
			</td><td class="tableLineRight">UI.ProgressBar</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#setGuage" class="methodLink">setGuage</a>( <em>id:String|Tag</em>,&nbsp;&nbsp;<em>text:String</em> )&nbsp;:&nbsp;none<br/>
				设置进度条控件的进度指示显示参数。
			</td><td class="tableLineRight alt">UI.ProgressBar</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#setPER" class="methodLink">setPER</a>( <em>per:Number|(PER String)</em> )&nbsp;:&nbsp;none<br/>
				设置进度条控件的进度指示器宽度。
			</td><td class="tableLineRight">UI.ProgressBar</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#setWidth" class="methodLink">setWidth</a>( <em>width:Number|(PER String)</em> )&nbsp;:&nbsp;none<br/>
				设置进度条控件的宽度。
			</td><td class="tableLineRight alt">UI.ProgressBar</td>
		</tr>
		<tr>
			<td class="tableLineLeft">
				<a href="#start" class="methodLink">start</a>()&nbsp;:&nbsp;none<br/>
				开始一次进度显示。
			</td><td class="tableLineRight">UI.ProgressBar</td>
		</tr>
		<tr>
			<td class="tableLineLeft alt">
				<a href="#stop" class="methodLink">stop</a>()&nbsp;:&nbsp;none<br/>
				终止当前进度显示。
			</td><td class="tableLineRight alt">UI.ProgressBar</td>
		</tr>
	</tbody>
</table>

<!--相关事件-->
<a name="events"></a>
<h2>相关事件</h2>
<div class="properties">本类无相关事件。</div><br/>

<hr>

<!--相关属性的详细说明-->
<h2>本类属性的详细说明</h2>
<div class="detailWrap">

<a name="UI.ProgressBar.dom"></a>
<div class="mdetail">
	<h3>UI.ProgressBar.dom</h3><br/>
	<div class="mdetailDetails">
		进度条控件的页面标签对象。<br/>
		通过 dom 属性可直接对进度条进行操作。
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

</div><br/>

<!--相关方法的详细说明-->
<h2>本类方法的详细说明</h2>
<div class="detailWrap">

<a name="finish"></a>
<div class="mdetail">
	<h3>finish</h3>
	<div class="functionDefine">public function finish()</div>
	<div class="mdetailDetails">
		完成控件当前的进度显示。<br/>
		当调用了start方法以后, 可调用本方法结束当前的进度显示, 并设置控件的进度状态为100%。
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

<a name="setGuage"></a>
<div class="mdetail alt">
	<h3>setGuage</h3>
	<div class="functionDefine">public function setGuage( id:String|Tag, text:String )</div>
	<div class="mdetailDetails">
		设置进度条控件的进度指示显示参数。
		在设置了显示参数以后, 再调用start方法时, 将在页面ID所指定的位置显示相关的进度信息。
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>id</em> : String</li>
			<div class="subDesc">显示进度信息的页面标签ID或标签对象。</div>
			<li><em>text</em> : String</li>
			<div class="subDesc">进度信息的文本格式, text文本中必须要包含 "@PER@" 字符串, "@PER@" 就是显示百分比的位置。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

<a name="setPER"></a>
<div class="mdetail">
	<h3>setPER</h3>
	<div class="functionDefine">public function setPER( per:Number|(PER String) )</div>
	<div class="mdetailDetails">
		设置进度条控件的进度指示器宽度, 本方法一般应用在静态进度条上。
	</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>per</em> : Number|(PER String)</li>
			<div class="subDesc">进度指示器的宽度<br/>参数的取值&nbsp;&nbsp;&nbsp;&nbsp;0-1之间的两位小数或0-100的百分数。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

<a name="setWidth"></a>
<div class="mdetail alt">
		<h3>setWidth</h3>
	<div class="functionDefine">public function setWidth( width:Number|(PER String) )</div>
	<div class="mdetailDetails">设置进度条控件的宽度。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul>
			<li><em>width</em> : Number|(PER String)</li>
			<div class="subDesc">进度条控件的宽度, 默认值: 180px<br/>参数的取值&nbsp;&nbsp;&nbsp;&nbsp;1-999之间的整数或1-100的百分数。</div>
		</ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

<a name="start"></a>
<div class="mdetail">
	<h3>start</h3>
	<div class="functionDefine">public function start()</div>
	<div class="mdetailDetails">开始一次进度显示。<br/>
		当执行一个业务请求时, 调用本方法, 当业务请求执行完成时, 调用finish方法结束进度显示, <br/>如果中途停止了请求则调用stop方法结束进度显示。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

<a name="stop"></a>
<div class="mdetail alt">
	<h3>stop</h3>
	<div class="functionDefine">public function stop()</div>
	<div class="mdetailDetails">终止当前进度显示, 具体应用参见 <a href="#start" class="methodLink">start</a> 方法。</div><br/>
	<div class="mdetailDetails"><b>参数</b>
		<ul><li>无</li></ul>
		<b>返回值</b>
		<ul><li>无</li></ul>
	</div>
	<div class="footer since">@since JSR2.0&nbsp;&nbsp;&nbsp;&nbsp;<a href="ui_ProgressBar_API.html">Return</a></div><br/>
</div>

</div><br/>

<!--应用示例-->
<a name="examples"></a>
<h2>应用示例</h2>
<div class="properties"><a href="../Example/ui_ProgressBar.html" target="_blank">ui_ProgressBar.html</a></div><br/>

<!--页脚-->
<hr>
<div class="footer">JSR - Copyright &copy; 2007-2008 Jsr JS, LLC<br/>All rights reserved.</div>
</body>
</html>
